home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / dev / gui / BGUI11B.lha / docs / seperatorclass.doc < prev    next >
Text File  |  1994-07-31  |  3KB  |  90 lines
  1.  
  2.            $RCSfile: seperatorclass.doc,v $
  3.         Description: Seperatorclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.1 $
  10.               $Date: 1994/07/25 20:25:13 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. seperatorclass/--background--
  16. seperatorclass/Methods
  17. seperatorclass/Attributes
  18.  
  19. seperatorclass/--background--                    seperatorclass/--background--
  20.  
  21.     NAME
  22.         Class:          seperatorclass
  23.         Superclass:     GADGETCLASS
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide  you  with  a  simple  way to seperate different groups of
  28.         objects with a single 3D line with or without a descriptive title.  As
  29.         this class is read-only it will not send out any form of notification.
  30.  
  31. seperatorclass/Methods                                  seperatorclass/Methods
  32.  
  33.     NEW METHODS
  34.         None.
  35.  
  36.     CHANGED METHODS
  37.         None.
  38.  
  39. seperatorclass/Attributes                            seperatorclass/Attributes
  40.  
  41.     NAME
  42.         SEP_Horiz -- ( BOOL )
  43.  
  44.     FUNCTION
  45.         To  make  the  seperator a horizontal one. By default the seperator is
  46.         vertical.  Vertical  seperators  must be used in horizontal groups and
  47.         horizontal seperators in vertical groups.
  48.  
  49.         Default is FALSE. Applicability is (I).
  50.  
  51.     NAME
  52.         SEP_Title -- ( STRPTR )
  53.  
  54.     FUNCTION
  55.         To  give  the  seperator  a  descriptive  title. Please note that this
  56.         attribute is only useful and processed for horizontal seperators.
  57.  
  58.         Default is NULL. Applicability is (I).
  59.  
  60.     NAME
  61.         SEP_Thin -- ( BOOL )
  62.  
  63.     FUNCTION
  64.         To  make  the  seperator thin which means that the width of the bar is
  65.         reduced  to two pixels. Please note that this attribute is only useful
  66.         and processed for vertical seperators.
  67.  
  68.         Default is FALSE. Applicability is (I).
  69.  
  70.     NAME
  71.         SEP_Highlight -- ( BOOL )
  72.  
  73.     FUNCTION
  74.         To  render  the  seperator title using the HIGHLIGHTTEXTPEN instead of
  75.         the  default  TEXTPEN  color.  Please note that this attribute is only
  76.         useful and processed for horizontal seperators.
  77.  
  78.         Default is FALSE. Applicability is (I).
  79.  
  80.     NAME
  81.         SEP_CenterTitle -- ( BOOL )
  82.  
  83.     FUNCTION
  84.         To  render  the  seperator  title  in  the center of the seperator bar
  85.         instead  of  the  text  baseline on the seperator bar. Please not that
  86.         this attribute is only useful and processed for horizontal seperators.
  87.  
  88.  
  89.         Default is FALSE. Applicability is (I).
  90.